<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>@aws/dynamodb-data-mapper-annotations</title>
	<meta name="description" content="">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="index.html" class="title">@aws/dynamodb-data-mapper-annotations</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="globals.html">Globals</a>
				</li>
			</ul>
			<h1> @aws/dynamodb-data-mapper-annotations</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Classes</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-class"><a href="classes/author.html" class="tsd-kind-icon">Author</a></li>
								<li class="tsd-kind-class"><a href="classes/comment.html" class="tsd-kind-icon">Comment</a></li>
								<li class="tsd-kind-class"><a href="classes/post.html" class="tsd-kind-icon">Post</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Interfaces</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-interface"><a href="interfaces/classannotation.html" class="tsd-kind-icon">Class<wbr>Annotation</a></li>
								<li class="tsd-kind-interface"><a href="interfaces/propertyannotation.html" class="tsd-kind-icon">Property<wbr>Annotation</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Variables</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-variable"><a href="globals.html#metadata_type_key" class="tsd-kind-icon">METADATA_<wbr>TYPE_<wbr>KEY</a></li>
							</ul>
						</section>
						<section class="tsd-index-section ">
							<h3>Functions</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-function"><a href="globals.html#attribute" class="tsd-kind-icon">attribute</a></li>
								<li class="tsd-kind-function"><a href="globals.html#autogeneratedhashkey" class="tsd-kind-icon">auto<wbr>Generated<wbr>Hash<wbr>Key</a></li>
								<li class="tsd-kind-function"><a href="globals.html#hashkey" class="tsd-kind-icon">hash<wbr>Key</a></li>
								<li class="tsd-kind-function"><a href="globals.html#rangekey" class="tsd-kind-icon">range<wbr>Key</a></li>
								<li class="tsd-kind-function"><a href="globals.html#table" class="tsd-kind-icon">table</a></li>
								<li class="tsd-kind-function"><a href="globals.html#versionattribute" class="tsd-kind-icon">version<wbr>Attribute</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Variables</h2>
				<section class="tsd-panel tsd-member tsd-kind-variable">
					<a name="metadata_type_key" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagConst">Const</span> METADATA_<wbr>TYPE_<wbr>KEY</h3>
					<div class="tsd-signature tsd-kind-icon">METADATA_<wbr>TYPE_<wbr>KEY<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"design:type"</span><span class="tsd-signature-symbol"> =&nbsp;&quot;design:type&quot;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/constants.ts#L1">constants.ts:1</a></li>
						</ul>
					</aside>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Functions</h2>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="attribute" class="tsd-anchor"></a>
					<h3>attribute</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">attribute<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SchemaType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/attribute.ts#L59">attribute.ts:59</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Declare a property in a TypeScript class to be part of a DynamoDB schema.
										Meant to be used as a property decorator in conjunction with TypeScript&#39;s
										emitted type metadata. If used with in a project compiled with the
										<code>emitDecoratorMetadata</code> option enabled, the type will infer most types from
									the TypeScript source.</p>
								</div>
								<p>Please note that TypeScript does not emit any metadata about the type
									parameters supplied to generic types, so <code>Array&lt;string&gt;</code>, <code>[number, string]</code>,
									and <code>MyClass[]</code> are all exposed as <code>Array</code> via the emitted metadata. Without
									additional metadata, this annotation will treat all encountered arrays as
									collections of untyped data. You may supply either a <code>members</code> declaration or
									a <code>memberType</code> declaration to direct this annotation to treat a property as a
								tuple or typed list, respectively.</p>
								<p>Member type declarations are required for maps and sets.</p>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.typescriptlang.org/docs/handbook/decorators.html">https://www.typescriptlang.org/docs/handbook/decorators.html</a></p>
									</dd>
									<dt>see</dt>
									<dd><p><a href="https://www.typescriptlang.org/docs/handbook/compiler-options.html">https://www.typescriptlang.org/docs/handbook/compiler-options.html</a></p>
									</dd>
									<dt>see</dt>
									<dd><p><a href="https://github.com/Microsoft/TypeScript/issues/2577">https://github.com/Microsoft/TypeScript/issues/2577</a></p>
									</dd>
									<dt>example</dt>
									<dd><p> export class MyClass {
											@attribute()
										id: string;</p>
										<pre><code> @<span class="hljs-keyword">attribute</span>()
 subdocument?: MyOtherClass;

 @<span class="hljs-keyword">attribute</span>()
 untypedCollection?: Array&lt;any&gt;;

 @<span class="hljs-keyword">attribute</span>({<span class="hljs-selector-tag">memberType</span>: {<span class="hljs-attribute">type</span>: <span class="hljs-string">'String'</span>}})
 <span class="hljs-selector-tag">listOfStrings</span>?: <span class="hljs-selector-tag">Array</span>&lt;<span class="hljs-selector-tag">string</span>&gt;;

 @<span class="hljs-keyword">attribute</span>({<span class="hljs-selector-tag">members</span>: <span class="hljs-selector-attr">[{type: 'Boolean', type: 'String'}]</span>})
 <span class="hljs-selector-tag">tuple</span>?: <span class="hljs-selector-attr">[boolean, string]</span>;

 @<span class="hljs-keyword">attribute</span>({<span class="hljs-selector-tag">memberType</span>: {<span class="hljs-attribute">type</span>: <span class="hljs-string">'String'</span>}})
 <span class="hljs-selector-tag">mapStringString</span>?: <span class="hljs-selector-tag">Map</span>&lt;<span class="hljs-selector-tag">string</span>, <span class="hljs-selector-tag">string</span>&gt;;

 @<span class="hljs-keyword">attribute</span>()
 binary?: Uint8Array;
</code></pre><p> }</p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> parameters: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">SchemaType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="autogeneratedhashkey" class="tsd-anchor"></a>
					<h3>auto<wbr>Generated<wbr>Hash<wbr>Key</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">auto<wbr>Generated<wbr>Hash<wbr>Key<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/autoGeneratedHashKey.ts#L6">autoGeneratedHashKey.ts:6</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> parameters: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="hashkey" class="tsd-anchor"></a>
					<h3>hash<wbr>Key</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">hash<wbr>Key<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BinaryType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DateType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/hashKey.ts#L11">hashKey.ts:11</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> parameters: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BinaryType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DateType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="rangekey" class="tsd-anchor"></a>
					<h3>range<wbr>Key</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">range<wbr>Key<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BinaryType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DateType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/rangeKey.ts#L11">rangeKey.ts:11</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> parameters: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">BinaryType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">CustomType</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">DateType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">StringType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="table" class="tsd-anchor"></a>
					<h3>table</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">table<span class="tsd-signature-symbol">(</span>tableName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/classannotation.html" class="tsd-signature-type">ClassAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/table.ts#L13">table.ts:13</a></li>
								</ul>
							</aside>
							<div class="tsd-comment tsd-typography">
								<div class="lead">
									<p>Declare a TypeScript class to be represent items in a table in a way
										understandable by the AWS DynamoDB DataMapper for JavaScript. Meant to be
										used as a TypeScript class decorator in projects compiled with the
									<code>experimentalDecorators</code> option enabled.</p>
								</div>
								<dl class="tsd-comment-tags">
									<dt>see</dt>
									<dd><p><a href="https://www.typescriptlang.org/docs/handbook/decorators.html">https://www.typescriptlang.org/docs/handbook/decorators.html</a></p>
									</dd>
									<dt>see</dt>
									<dd><p><a href="https://www.typescriptlang.org/docs/handbook/compiler-options.html">https://www.typescriptlang.org/docs/handbook/compiler-options.html</a></p>
									</dd>
								</dl>
							</div>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5>tableName: <span class="tsd-signature-type">string</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/classannotation.html" class="tsd-signature-type">ClassAnnotation</a></h4>
						</li>
					</ul>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-function">
					<a name="versionattribute" class="tsd-anchor"></a>
					<h3>version<wbr>Attribute</h3>
					<ul class="tsd-signatures tsd-kind-function">
						<li class="tsd-signature tsd-kind-icon">version<wbr>Attribute<span class="tsd-signature-symbol">(</span>parameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></li>
					</ul>
					<ul class="tsd-descriptions">
						<li class="tsd-description">
							<aside class="tsd-sources">
								<ul>
									<li>Defined in <a href="https://github.com/awslabs/dynamodb-data-mapper-js/blob/c504011/packages/dynamodb-data-mapper-annotations/src/versionAttribute.ts#L5">versionAttribute.ts:5</a></li>
								</ul>
							</aside>
							<h4 class="tsd-parameters-title">Parameters</h4>
							<ul class="tsd-parameters">
								<li>
									<h5><span class="tsd-flag ts-flagDefault value">Default value</span> parameters: <span class="tsd-signature-type">Partial</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">NumberType</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5>
								</li>
							</ul>
							<h4 class="tsd-returns-title">Returns <a href="interfaces/propertyannotation.html" class="tsd-signature-type">PropertyAnnotation</a></h4>
						</li>
					</ul>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class="globals current ">
						<a href="globals.html"><em>Globals</em></a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
					<li class=" tsd-kind-class">
						<a href="classes/author.html" class="tsd-kind-icon">Author</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/comment.html" class="tsd-kind-icon">Comment</a>
					</li>
					<li class=" tsd-kind-class">
						<a href="classes/post.html" class="tsd-kind-icon">Post</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/classannotation.html" class="tsd-kind-icon">Class<wbr>Annotation</a>
					</li>
					<li class=" tsd-kind-interface">
						<a href="interfaces/propertyannotation.html" class="tsd-kind-icon">Property<wbr>Annotation</a>
					</li>
					<li class=" tsd-kind-variable">
						<a href="globals.html#metadata_type_key" class="tsd-kind-icon">METADATA_<wbr>TYPE_<wbr>KEY</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#attribute" class="tsd-kind-icon">attribute</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#autogeneratedhashkey" class="tsd-kind-icon">auto<wbr>Generated<wbr>Hash<wbr>Key</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#hashkey" class="tsd-kind-icon">hash<wbr>Key</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#rangekey" class="tsd-kind-icon">range<wbr>Key</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#table" class="tsd-kind-icon">table</a>
					</li>
					<li class=" tsd-kind-function">
						<a href="globals.html#versionattribute" class="tsd-kind-icon">version<wbr>Attribute</a>
					</li>
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer>
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>